🔗 Linked issue

FriendsOfAdonis/FriendsOfAdonis#48

❓ Type of change

• 🐞 Bug fix (a non-breaking change that fixes an issue)
• 👌 Enhancement (improving an existing functionality like performance)
• ✨ New feature (a non-breaking change that adds functionality)
• ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

This pull-request removes the ForceJsonResponseMiddleware from the server middlewares and add it to the named middleware. The start/routes.ts is updated accordingly by providing an initial api group that uses this middleware.

This allows library authors to perform content-negotiation without requiring users to update their existing codebase. And this is a main issue for @foadonis/openapi where the content returned depends on the Accept header allowing them to use the same route for documentation UI and in tools like openapi-typescript.

On a side not I think this middleware should not exist at all. Libraries should instead rely on content negotiation as it is already something managed by browsers.

For example, here is the default Accept header on Chrome

• document request: text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7
• fetch request: */*

With the following example, Accept is html on document request and json on fetch request.

router.get('/', ({ request }) => {
  const accept = request.accepts(['json', 'html'])
})

Also users should always define their accept header when making api request but this is a different story.

📝 Checklist

• I have linked an issue or discussion.
• I have updated the documentation accordingly. (n/a)